|
Eclipse JDT Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jdt.launching.VMRunnerConfiguration
Holder for various arguments passed to a VM runner. Mandatory parameters are passed in the constructor; optional arguments, via setters.
Clients may instantiate this class; it is not intended to be subclassed.
Constructor Summary | |
VMRunnerConfiguration(String classToLaunch,
String[] classPath)
Creates a new configuration for launching a VM to run the given main class using the given class path. |
Method Summary | |
String[] |
getAppendBootClassPath()
Return the classpath entries to append to the boot classpath, or null null if none |
String[] |
getBootClassPath()
Returns the boot classpath. |
String[] |
getClassPath()
Returns the classpath. |
String |
getClassToLaunch()
Returns the name of the class to launch. |
String[] |
getEnvironment()
Returns the environment for the Java program or null |
String[] |
getMainBootClassPath()
Return the main part of the boot classpath - null represents the default boot classpath. |
String[] |
getPrependBootClassPath()
Return the classpath entries to prepend to the boot classpath, or null if none. |
String[] |
getProgramArguments()
Returns the arguments to the Java program. |
String[] |
getVMArguments()
Returns the arguments to the VM itself. |
Map |
getVMSpecificAttributesMap()
Returns the Map that contains String name/value pairs that represent
VM-specific attributes. |
String |
getWorkingDirectory()
Returns the working directory of a launched VM. |
void |
setAppendBootClassPath(String[] appendBootClassPath)
Sets the classpath entries to append to the boot classpath - null
or empty if none. |
void |
setBootClassPath(String[] bootClassPath)
Sets the boot classpath. |
void |
setEnvironment(String[] environment)
Sets the environment for the Java program. |
void |
setMainBootClassPath(String[] bootClassPath)
Sets the main boot classpath entries. |
void |
setPrependBootClassPath(String[] prependBootClassPath)
Sets the classpath entries to prepend to the boot classpath - null
or empty if none. |
void |
setProgramArguments(String[] args)
Sets the custom program arguments. |
void |
setVMArguments(String[] args)
Sets the custom VM arguments. |
void |
setVMSpecificAttributesMap(Map map)
Sets the Map that contains String name/value pairs that represent
VM-specific attributes. |
void |
setWorkingDirectory(String path)
Sets the working directory for a launched VM. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public VMRunnerConfiguration(String classToLaunch, String[] classPath)
classToLaunch
- The fully qualified name of the class to launch. May not be null.classPath
- The classpath. May not be null.Method Detail |
public void setVMSpecificAttributesMap(Map map)
Map
that contains String name/value pairs that represent
VM-specific attributes.
map
- the Map
of VM-specific attributes.public void setVMArguments(String[] args)
args
- the list of VM argumentspublic void setProgramArguments(String[] args)
args
- the list of argumentspublic void setEnvironment(String[] environment)
environment
- the environment for the Java program specified as an array
of strings, each element specifying an environment variable setting in the
format name=valuepublic void setPrependBootClassPath(String[] prependBootClassPath)
null
or empty if none.
prependBootClassPath
- the classpath entries to prepend to the boot classpath - null
or empty if nonepublic void setMainBootClassPath(String[] bootClassPath)
null
indicates the default boot classpath should be used
(i.e. not specified on the command line), and empty array indicates
an empty boot classpath attribute.
bootClassPath
- the main boot classpath entries, possibly null
public void setAppendBootClassPath(String[] appendBootClassPath)
null
or empty if none.
appendBootClassPath
- the entries to append to the boot classpath -
null
or empty indicates none.public void setBootClassPath(String[] bootClassPath)
In release 3.0, support has been added for appending and prepending the
boot classpath. Generally an IVMRunner
should use the prepend,
main, and append boot classpaths provided. However, in the case that an
IVMRunner
does not support these options, a complete boothpath
should also be specified.
bootClassPath
- The boot classpath. An emptry array indicates an empty
bootpath and null
indicates a default bootpath.public Map getVMSpecificAttributesMap()
Map
that contains String name/value pairs that represent
VM-specific attributes.
Map
of VM-specific attributes or null
.public String getClassToLaunch()
null
.public String[] getClassPath()
public String[] getPrependBootClassPath()
null
if none.
null
if nonepublic String[] getMainBootClassPath()
null
represents the default boot classpath.
public String[] getAppendBootClassPath()
null
null if none
null
if nonepublic String[] getBootClassPath()
null
indicates a default bootpah.
In 3.0, support has been added for prepending and appending to the boot classpath.
The methods #getPrependBootClassPath()
, #getMainBootClassPath()
,
and #getAppendBootClassPath()
should be used instead of this method
if an IVMRunner
supports the options, as they may return more accurate
information. In the case that the other options are not specified, and a single
boot classpath is provided, an IVMRunner
should honor the
boot classpath specified by this method.
null
indicates a default bootpah.setBootClassPath(String[])
public String[] getVMArguments()
null
.setVMArguments(String[])
public String[] getProgramArguments()
null
.setProgramArguments(String[])
public String[] getEnvironment()
null
null
public void setWorkingDirectory(String path)
path
- the absolute path to the working directory
to be used by a launched VM, or null
if
the default working directory is to be inherited from the
current processpublic String getWorkingDirectory()
null
if the working
directory is inherited from the current process
|
Eclipse JDT Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |